WHATIS

Section: Misc. Reference Manual Pages (5 )
Index Return to Main Contents
 

NAME

whatis - format of whatis(1) database  

DESCRIPTION

These files are used by whatis(1), apropos(1), and whatisin(1).

The databases are kept in separate file for each section of the manual, i.e.,

        whatis._0_
        whatis._1_
        whatis._2_
        etc.

        whatis._l_
        whatis._n_
        whatis._o_

Each line is either a comment or data. Comments are blank lines or those whose first character is a `#'.

The format for each data line of the databases is:

        name%aliases%section%subsection%description%xrefs%keywords

name
program/routine/etc name. (required)
alias
if this sources another manpage or refered by another name. a comma-separated list. (optional)
section
manual section number [0-9nlo]. (required)
subsection
single capital letter. (optional)
description
what this is, ascii string. (required)
xref
basically "SEE ALSO". a comma-separated list. (optional)
keywords
any descriptive keywords. comma-separated list. (optional)

Optional or unspecified fields contain only a `_' char.

Here is an example:

        unixmode%_%5%_%Extended Filename Standard%sh(1)%MiNT,file
 

SEE ALSO

whatis(1), apropos(1), whatisin(1), mkwhatis(8)  

AUTHOR

Bill Rosenkranz
rosenkra@convex.com  

VERSION

whatis.5 v2.0.1 92/9/12 rosenkra


 

Index

NAME
DESCRIPTION
SEE ALSO
AUTHOR
VERSION

This document was created by man2html, using the manual pages.
Time: 03:58:28 GMT, September 10, 2022